Add notes to jerry_create_undefined #4790
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matedabis
force-pushed
the
document_update
branch
from
6243768 to
fdcee3e
Compare
zherczeg
requested changes
Oct 5, 2021
docs/02.API-REFERENCE.md
Outdated
| @@ -8176,6 +8176,11 @@ main (void) | |||
|
|
|||
| Creates a `jerry_value_t` representing an undefined value. | |||
|
|
|||
| *Notes*: | |||
| - Calling [jerry_release_value](#jerry_release_value) is optional. | |||
| - Calling [jerry_acquire_value](#jerry_acquire_value) is optional. | |||
There was a problem hiding this comment.
I would write something like this:
The undefined value is a fixed constant. Its value can be copied any number of times without calling jerry_acquire_value, and freeing it with jerry_release_value is optional.
This is also true for true/false/null values, so add this comment to them.
matedabis
force-pushed
the
document_update
branch
from
fdcee3e to
c558213
Compare
zherczeg
requested changes
Oct 6, 2021
docs/02.API-REFERENCE.md
Outdated
| @@ -6870,6 +6870,9 @@ jerry_create_shared_arraybuffer_external (const jerry_length_t size | |||
|
|
|||
| Create a jerry_value_t representing a boolean value from the given boolean parameter. | |||
|
|
|||
| *Notes*: | |||
| - The undefined value is a fixed constant. Its value can be copied any number of times without calling [jerry_acquire_value](#jerry_acquire_value), and freeing it with [jerry_release_value](#jerry_release_value) is optional. | |||
There was a problem hiding this comment.
undefined value -> boolean values (true/false)
docs/02.API-REFERENCE.md
Outdated
| @@ -7238,6 +7241,9 @@ jerry_create_number_nan (void); | |||
|
|
|||
| Creates and returns a `jerry_value_t` with type null object. | |||
|
|
|||
| *Notes*: | |||
| - The undefined value is a fixed constant. Its value can be copied any number of times without calling [jerry_acquire_value](#jerry_acquire_value), and freeing it with [jerry_release_value](#jerry_release_value) is optional. | |||
matedabis
force-pushed
the
document_update
branch
from
c558213 to
a017e9f
Compare
zherczeg
requested changes
Oct 7, 2021
docs/02.API-REFERENCE.md
Outdated
| @@ -6870,6 +6870,10 @@ jerry_create_shared_arraybuffer_external (const jerry_length_t size | |||
|
|
|||
| Create a jerry_value_t representing a boolean value from the given boolean parameter. | |||
|
|
|||
| *Notes*: | |||
| - The boolean values (true/false) are fixed constants. Its value can be copied any number of times without calling | |||
…te_boolean JerryScript-DCO-1.0-Signed-off-by: Mate Dabis [email protected]
matedabis
force-pushed
the
document_update
branch
from
a017e9f to
fc995bb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.